JBoss.orgCommunity Documentation

Overlord APIMan Guide


1. Introduction to APIMan
1.1. What is API Management?
1.2. Project Goals
1.3. Typical Use Cases
1.3.1. Security
1.3.2. Throttling
1.3.3. Metering
2. Getting Started
3. Installation Guide
4. User Guide
4.1. Overview
4.2. Management Layer
4.2.1. Concepts
4.2.2. Data Model
4.2.3. User Management
4.2.4. Managing Organizations
4.2.5. Managing Plans
4.2.6. Providing Services
4.2.7. Consuming Services
4.3. Runtime Layer
4.3.1. Configuration
4.3.2. Invoking Services
5. Developer Guide
5.1. Building the Project
5.2. Reporting Problems
5.3. Setting up a Development Environment
5.4. Architecture
5.5. Plugin Framework
5.6. Contribution Points
5.6.1. Policy Implementations
5.6.2. Policy Configuration UI Forms
5.6.3. Components
Bibliography

This section of the project documentation is intended to be used by end users of the system. If you are using JBoss overlord API management to either provide or consume API’s then this guide should help you be successful.

It is perhaps most important to understand the various entities used by the management layer, as well as their relationships with each other.

The management layer offers user role capabilities at the organization level. Users can be members of organizations and have specific roles within those organizations. The roles themselves are configurable by an administrator, and each role provides the user with a set of permissions that determine what actions the user can take within an organization.

A core capability of API management is for end users to create, manage, and configure services they wish to provide. This section explains the steps necessary for end users to provide those services.

After the service providers have added a number of services to the API management system, those services can be consumed by applications. This section explains how to consume services.

The primary action taken when configuring an application is the creation of contracts to services. This is what we mean when we say “consuming a service”. There are a number of ways to create service contracts. This section will describe the most useful of these options.

From the application details page select the ‘Overview’ tab. Click on the ‘Search for services to consume’ link in the ‘Things To Do’ section. You will be taken to a page that will help you search for and find the service you wish to consume.

Use the controls on this page to search for a service. Once you have found the service you are interested in, click on its name in the search results area. This will take you to the service details page for service consumers. The consumer-oriented service details page presents you with all of the information necessary to make a decision about how to consume the service. It includes a list of all the service versions and a list of all of the available plans the service can be consumed through.

Note that you can click on an individual plan to see the details of the policies that will be enforced should that plan be chosen. Click on the ‘Create Contract’ button next to the plan you wish to use when consuming this service. You will be taken to the new contract page to confirm that you want to create a service contract to this service through the selected plan. If you are sure this is the service contract you wish to create, click the ‘Create Contract’ button and then agree to the terms and conditions. If successful, you will be taken to the ‘Contracts’ tab on the application details page.

From the ‘Contracts’ tab on the application details page you can see the list of service contracts already created for this application. It is also possible to break service contracts from this same list by clicking an appropriate ‘Break Contract’ button.